Platform Explorer / Nuxeo Platform 2023.21

Operation Document.RequestRetrievalFromColdStorage (Request retrieval from cold storage)

Description

Request a retrieval from cold storage of the content associated with the document.
Operation id Document.RequestRetrievalFromColdStorage
Category Files
Label Request retrieval from cold storage
Requires
Since

Parameters

Name Description Type Required Default value
numberOfDaysOfAvailability The number of days that you want your cold storage content to be accessible. int no  

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

Implementation Class Class: org.nuxeo.coldstorage.operations.RequestRetrievalFromColdStorage
Contributing Component org.nuxeo.coldstorage.operations.contrib

JSON Definition

{
  "id" : "Document.RequestRetrievalFromColdStorage",
  "label" : "Request retrieval from cold storage",
  "category" : "Files",
  "requires" : null,
  "description" : "Request a retrieval from cold storage of the content associated with the document.",
  "url" : "Document.RequestRetrievalFromColdStorage",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "numberOfDaysOfAvailability",
    "description" : "The number of days that you want your cold storage content to be accessible.",
    "type" : "int",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}